Inscoper::SubDeviceGroupConfig¶

SubDeviceGroupConfig class provides information for sub-device group configuration. More...

#include <SubDeviceGroupConfig.h>

Public Functions¶

	Name
	SubDeviceGroupConfig() Default constructor.
void	fromXML(Inscoper::XMLNode & groupNode) Provide sub-device group information from the XML node.
void	toXML(Inscoper::XMLNode & xmlParent) Export sub-device group information in an XML node attached to the parent XML node.
const std::string &	getName() const Get the name of the group.
void	setName(const std::string & name) Set the name of the group.
unsigned short	getTag() const Get the tag of the group.
void	setTag(unsigned short tag) Set the tag of the group.
Inscoper::NBO::ENBOType	getNBOType() const Get the NBO type of the group.
bool	hasNBOType() const Check if the NBO type of the group is set.
void	setNBOType(Inscoper::NBO::ENBOType nboType) Set the NBO type of the group.
void	unsetNBOType() Unset the NBO type of the group.
const std::vector< Inscoper::SubDeviceConfigPtr > &	getSubDeviceConfigList() const Get the sub-device configuration list.
void	setSubDeviceConfigList(const std::vector< Inscoper::SubDeviceConfigPtr > & subDevices) Set the sub-device configuration list.
void	addSubDeviceConfig(const Inscoper::SubDeviceConfigPtr & subDevice) Add a sub-device configuration to the list.

Detailed Description¶

class Inscoper::SubDeviceGroupConfig;

SubDeviceGroupConfig class provides information for sub-device group configuration.

This class holds the configuration parameters for a sub-device group, including its name, tag, NBO type, and associated sub-device configurations.

Public Functions Documentation¶

function SubDeviceGroupConfig¶

SubDeviceGroupConfig()

Default constructor.

Initializes a new instance of the SubDeviceGroupConfig class.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & groupNode
)

Provide sub-device group information from the XML node.

Parameters:

groupNode : The XML node containing sub-device group information

Exceptions:

InscoperException if an error occurred

Populates the sub-device group configuration from the provided XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Export sub-device group information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException if an error occurred

Serializes the sub-device group configuration to the specified parent XML node.

function getName¶

const std::string & getName() const

Get the name of the group.

Return: The name of the group

Retrieves the name of the sub-device group.

function setName¶

void setName(
    const std::string & name
)

Set the name of the group.

Parameters:

name : The name of the group

Sets the name of the sub-device group.

function getTag¶

unsigned short getTag() const

Get the tag of the group.

Return: The tag of the group

Retrieves the tag of the sub-device group.

function setTag¶

void setTag(
    unsigned short tag
)

Set the tag of the group.

Parameters:

tag : The tag of the group

Sets the tag of the sub-device group.

function getNBOType¶

Inscoper::NBO::ENBOType getNBOType() const

Get the NBO type of the group.

Return: The NBO type of the group

Retrieves the NBO type of the sub-device group.

function hasNBOType¶

bool hasNBOType() const

Check if the NBO type of the group is set.

Return: True if the NBO type is set, false otherwise

Checks whether an NBO type has been explicitly defined for this sub-device group.

function setNBOType¶

void setNBOType(
    Inscoper::NBO::ENBOType nboType
)

Set the NBO type of the group.

Parameters:

nboType : The NBO type of the group

Sets the NBO type of the sub-device group.

function unsetNBOType¶

void unsetNBOType()

Unset the NBO type of the group.

Removes the NBO type definition, making hasNBOType() return false.

function getSubDeviceConfigList¶

const std::vector< Inscoper::SubDeviceConfigPtr > & getSubDeviceConfigList() const

Get the sub-device configuration list.

Return: The list of sub-device configurations

Retrieves the list of sub-device configurations associated with this group.

function setSubDeviceConfigList¶

void setSubDeviceConfigList(
    const std::vector< Inscoper::SubDeviceConfigPtr > & subDevices
)

Set the sub-device configuration list.

Parameters:

subDevices : The list of sub-device configurations

Replaces the current list of sub-device configurations.

function addSubDeviceConfig¶

void addSubDeviceConfig(
    const Inscoper::SubDeviceConfigPtr & subDevice
)

Add a sub-device configuration to the list.

Parameters:

subDevice : The sub-device configuration to add

Appends a new sub-device configuration to the group.

Updated on 2026-06-23 at 10:35:20 +0200